/*********************************************************************
*
* Software License Agreement (BSD License)
*
*  Copyright (c) 2010, Heriot-Watt University, UK.
*  All rights reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*   * Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
*   * Redistributions in binary form must reproduce the above
*     copyright notice, this list of conditions and the following
*     disclaimer in the documentation and/or other materials provided
*     with the distribution.
*   * Neither the name of the Heriot-Watt University nor the names of
*     its contributors may be used to endorse or promote products
*     derived from this software without specific prior written
*     permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
*  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
*  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
*  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
*  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
*  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
*  POSSIBILITY OF SUCH DAMAGE.
*
*  Author: Joel Cartwright
*
*********************************************************************/

#ifndef SERVICE_ID_H_
#define SERVICE_ID_H_

#include <string>

#include <boost/shared_ptr.hpp>

#include <ros/ros.h>

namespace matchmaker
{

/**
 * @brief Unique identifier for an advertised service instance
 */
class ServiceID //: boost::noncopyable
{
public:
  /**
   * @brief Constructor taking the string form previously produced by a ServiceID
   *
   * If stringID does not represent a valid StringID, a call to isValid
   * on the created object will return false.
   *
   * @param stringID string form of ServiceID
   */
  ServiceID(const std::string & stringID);

  /**
   * @brief Constructor taking component parts of the ServiceID
   * @param providerName
   * @param topic
   */
  ServiceID(const std::string & providerName, const std::string & topic);

  /**
   * @brief Destructor
   */
  virtual ~ServiceID();

  /**
   * @brief Less than operator
   * @param rhs right hand side of comparison
   * @return true if this instance is 'less' than rhs
   */
  bool operator<(const ServiceID& rhs) const;

  /**
   * @brief Equality operator
   * @param rhs right hand side of comparison
   * @return true if this instance is equal to rhs
   */
  bool operator==(const ServiceID& rhs) const;

  /**
   * @brief Inequality operator
   * @param rhs right hand side of comparison
   * @return true if this instance is not equal to rhs
   */
  bool operator!=(const ServiceID& rhs) const;

  /**
   * @brief Creates a string form of the ServiceID
   * @return string representing this ServiceID
   */
  std::string toString() const;

  /**
   * @brief Tests instance for validity
   * @return true if the instance is valid, false otherwise
   */
  bool isValid() const;

private:
  /** Separator used between ID components in string form. */
  static const char SEPARATOR = ':';

  /** Name of the ROS node providing this service */
  std::string providerName_;

  /** ROS topic for this service */
  std::string topic_;

  friend class Server;
};

typedef boost::shared_ptr<ServiceID> ServiceIDPtr;

} // namespace

#endif /* SERVICE_ID_H_ */
